Pre-Populating Search Fields
This section lists parameters that can be appended to the base Self Service portal URLs for the purpose of pre-populating fields on search criteria pages in the vFire Self Service portal.
Knowledge Search
The Knowledge Search page in the Self Service Portal can be pre-populated by appending parameters to the basic Knowledge Search URL:
URL: http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria
Parameter |
Description |
---|---|
BTN_SEARCH http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&BTN_SEARCH=Search Example 1
Example 2
|
Add BTN_SEARCH=Search to the URL to automatically run the search. Users will be taken directly to the results page. If the URL does not contain this parameter, users are taken to the search criteria page where they will need to manually press the Search button. Example 1 opens the Knowledge Search Results page with a list of all knowledge articles published to the Portal. This is equivalent to clicking Search without having specified any search options. Example 2 opens the Knowledge Search Results page with a list of all FAQ and Known Issue knowledge entries published to the Portal. |
Type_List http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Type_List=<type_ref>,<type_ref>
Example: http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Type_List=501,503 |
Use this parameter to specify the knowledge type in the URL, such as FAQ or Call. The TYPE_LIST parameter can have multiple comma separated values. The example URL opens the Knowledge Search criteria page with the Known Issues and FAQ checkboxes already selected. The unique reference is found in ENTITY_TYPE.KB_BASE_TYPE in the database. The following values are the default values for each knowledge type, these values may differ in non-standard databases:
|
KnowledgeTemplate http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&KnowledgeTemplate=<kbtemplate>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&KnowledgeTemplate=FAQ If appending BTN_Search=Search to the example URL, the search results display automatically and include all knowledge articles, not just FAQ. To ensure articles of the correct type are returned when automating the search, include the Type_List parameter. |
Use this parameter to specify a non-default template for the knowledge search criteria page. The FAQ and KnownIssues templates display the heading as FAQ or Known Issues respectively, and offer different search options. The default knowledge search criteria template is LiteKnowledgeSearchResults.htm The example URL opens the FAQ Knowledge Search criteria page. Pressing Search on that window returns FAQ knowledge articles only. Search criteria templates exist in the system folder on the server. The following values can be passed to this parameter:
|
Format_Template http://<server_name>/<virtual_directory>/Core.aspx? Lite&Form=KnowledgeSearchCriteria&Format_Template=<format_file>
http://<server_name>/<virtual_directory>/Core.aspx? Lite&Form=KnowledgeSearchCriteria&Format_Template=FormatLiteFAQ&KnowledgeTemplate=FAQ As shown in the example, when using Format_Template, you must append a compatible KnowledgeTemplate parameter otherwise formatting issues may occur. |
Use this parameter to specify a non-default template for the search results page. These templates control the format of the rows in the results. The default knowledge results format template is FormatKnowledgeSearchLite.ifmt The example URL displays results using the format defined for FAQs. The templates are found in the Format folder under the system folder on the server. Templates that ship with the application:
|
Search_Query http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Search_Query=<text>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Search_Query=broken laptop screen |
Use this parameter to populate the Search Text field on the search window. The example URL opens the knowledge search criteria window with the words “broken laptop screen” in the Search Text field. This parameter can be blank. |
All_Words http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&All_Words=<Y/N>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&All_Words=N |
Use this parameter to enable one of the Search Text radio buttons on the search window. The default selection is All Words. The example URL opens the knowledge search criteria window with the Any Words radio button selected. Options available:
|
Text_Search_Type http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Text_Search_Type=<type>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Text_Search_Type=R |
Use this parameter to enable one of the Search Type radio buttons on the search window. The default selection is Exact. The example URL opens the knowledge search criteria window with the Regular Expression radio button selected. Options available:
|
Article_Ref http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Article_Ref=<number>,<number>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Article_Ref=32,17 |
Use this parameter to populate the Article Numbers field on the search window. This parameter can have multiple comma separated values. Article numbers are visible on the Knowledge Details in vFire Core. The example URL opens the knowledge search criteria window with 32,17 already entered. |
Profile_Ref http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Profile_Ref=<prof_ref>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Profile_Ref=32 |
Use this parameter to populate the Profile field on the search window, which is a tiered list. The example URL opens the Knowledge Search criteria page with the profile value Process/HR already selected, which is the NAME value for REF 32 in the database. Knowledge Profiles are created in System Admin. The unique reference is found in REF.KB_PROFILE in the database. |
CMDB_Item_Ref http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&CMDB_Item_Ref=<item_ref>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&CMDB_Item_Ref=32 |
Use this parameter to populate the CMDB Item field on the search window. The example URL opens the Knowledge Search criteria page with the CMDB Item Email Server already selected, which is the name value for REF 32 in the database. CMDB Items are created in vFire Core. The unique reference is found in ITEM_REF.AR_PRIMARY_ASSET in the database. |
Ref_Composite http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Ref_Composite=<problem_type>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Ref_Composite=32 |
Use this parameter to populate the Type field on the search window, which is a tiered list. The example URL opens the Knowledge Search criteria page with the Type value Payroll/Expenses already selected, which is the NAME value for REF 32 in the database. Types are created in System Admin. The unique reference is found in REF.CL_PROBLEM_TYPE in the database. |
Update_Date_Day http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Update_Date_Day=<day>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Update_Date_Day=12 |
Use this parameter to populate the day (dd) value in the Updated Since date picker field on the search window. The example URL opens the Knowledge Search criteria page with 12 already selected in the day (dd) portion of the Updated Since field. Up to 2 digits are accepted. |
Update_Date_Month http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Update_Date_Month=<month>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Update_Date_Month=10 |
Use this parameter to populate the month (MM) value in the Updated Since date picker field on the search window. The example URL opens the Knowledge Search criteria page with 10 already selected in the month (MM) portion of the Updated Since field. Up to 2 digits are accepted, between 1 and 12. |
Update_Date_Year http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Update_Date_Month=<year>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Update_Date_Year=2016 |
Use this parameter to populate the year (yyyy) value in the Updated Since date picker field on the search window. The example URL opens the Knowledge Search criteria page with 2016 already selected in the year (yyyy) portion of the Updated Since field. Up to 4 digits are accepted, between 1900 and 3000. |
Update_Date_Day, Update_Date_Year, Update_Date_Month http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Update_Date_Day=12&Update_Date_Year=2016&Update_Date_Month=10
|
Use these parameters in combination to populate the Updated Since field on the search window. The example URL opens the Knowledge Search criteria page with 12/10/2016 already selected. |
Knowledge_Order_By http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=KnowledgeSearchCriteria&Knowledge_Order_By=<order>
Example 1:
When appending BTN_SEARCH=Search to the URL, some of the Sort By options will not sort the results unless additional criteria is added to the URL. This reflects Portal Knowledge Search behavior. Refer to the examples below. Example 2 – returns an unsorted list of all knowledge articles: Example 3 – returns a sorted list of knowledge articles containing the text “email”: |
Use this parameter to populate the Sort By parameter on the search window. The default selection is Search Score (_rank). The URL in example 1 opens the knowledge search criteria window with Rating already selected. Options available:
The space in the last two options is intentional and represents descending vs ascending. |
Incident Search
The Review Past/Current Incidents window can be pre-populated by appending parameters to the basic Incident search URL.
URL: http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria
Parameter |
Description |
---|---|
Incident_Owner http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Incident_Owner=<owner_flag>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Incident_Owner=O
|
Use this parameter to pre-select one of the options of the Search within field on the search window, which is a set of radio options. The default selection is Your Incidents. The example URL opens the Review Past/Current Incidents criteria page with the Search Within option Your Organization’s Incidents already selected. Options available:
|
Call_Numbers http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Call_Numbers=<number>,<number>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Call_Numbers=10,15 |
Use this parameter to populate the Incident No field on the search window. This parameter can have multiple comma separated values. The example URL opens the Review Past/Current Incidents criteria page with values 10,15 already entered. Incident numbers are visible on the Incident Details window in vFire Core. |
Status http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Status=<status>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Status=1
|
Use this parameter to pre-select one of the options of the Incident State field on the search window, which is a set of radio options. The default selection is Open Incidents. The example URL opens the Review Past/Current Incidents criteria page with the Incident State value Resolved < 1 Week already selected. Options available:
|
Text_Search http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Text_Search=<text>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Text_Search=broken laptop screen |
Use this parameter to populate the Text Search field on the search window. The example URL opens the Review Past/Current Incidents criteria page with the words “broken laptop screen” in the Text Search field. This parameter can be blank. |
Service_Ref http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Service_Ref=<service_ref>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Service_Ref=22 |
Use this parameter to populate the Service field on the search window. The example URL opens the Review Past/Current Incidents criteria page with the Service Consulting already selected, which is the name value for REF 22 in the database. Services are created in vFire Core. The unique reference is found in ITEM_REF.AR_PRIMARY_ASSET in the database. |
Ref_Composite http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Ref_Composite=<ref_comp>
http://<server_name>/<virtual_directory>/Core.aspx?Lite& Form=CallSearchCriteria&Ref_Composite=22 |
Use this parameter to populate the Type field on the search window, which is a tiered list. The example URL opens the Review Past/Current Incidents criteria page with the Type value Payroll/Expenses already selected, which is the name value for REF 22 in the database. Types are created in System Admin. The unique reference is found in REF.CL_PROBLEM_TYPE in the database. |
Call_Priority http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Call_Priority=<priority_ref>
http://<server_name>/<virtual_directory>/Core.aspx?Lite& Form=CallSearchCriteria&Call_Priority=3 |
Use this parameter to populate the Priority field on the search window, which is a dropdown list. The example URL opens the Review Past/Current Incidents criteria page with the Priority High already selected, which is the name value for REF 3 in the database. Priorities are created in System Admin. The unique reference is found in REF.SU_CALL_PRIORITY in the database. |
Date_From http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Date_From=<date>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Date_From=2015-12-09 |
Use this parameter to populate the Logged Date From field on the search window. The example URL opens the Review Past/Current Incidents criteria page with 2015-12-09 already entered in the Logged Date From field. The format is YYYY-MM-DD |
Date_To http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Date_To=<date>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=CallSearchCriteria&Date_To=2015-12-09 |
Use this parameter to populate the Logged Date To field on the search window. The example URL opens the Review Past/Current Incidents criteria page with 2015-12-09 already entered in the Logged Date To field. The format is YYYY-MM-DD |
Request Search
The Review Past/Current Requests window can be pre-populated by appending parameters to the basic Request search URL.
URL: http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=RequestSearchCriteria
Parameter |
Description |
---|---|
Request_Owner http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=RequestSearchCriteria&Request_Owner=<owner_flag>
http://<server_name>/<virtual_directory>/Core.aspx?Lite& Form=RequestSearchCriteria&Request_Owner=O
|
Use this parameter to pre-select one of the options of the Search within field on the search window, which is a set of radio options. The default selection is Your Requests. The example URL opens the Review Past/Current Requests criteria page with the Search Within option Your Organization’s Requests already selected. Options available:
|
Request_Nos http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=RequestSearchCriteria&Request_Nos=<number>,<number>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=RequestSearchCriteria&Request_Nos=10,15 |
Use this parameter to populate the Request No field on the search window. This parameter can have multiple comma separated values. The example URL opens the Review Past/Current Requests criteria page with values 10,15 already entered. Running the search returns Requests 10 and 15, if they exist. Request numbers are visible on the Request Details window in vFire Core. |
Status http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=RequestSearchCriteria&Status=<status>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=RequestSearchCriteria&Status=1
|
Use this parameter to pre-select one of the options of the Request State field on the search window, which is a set of radio options. The default selection is Open Requests. The example URL opens the Review Past/Current Requests criteria page with the Request State value Closed < 1 Week already selected. Options available:
|
Browse the Service Catalog
The Browse the Service Catalog window can be pre-populated by appending parameters to the basic Service Catalog search URL. It is also possible to select individual Service Actions and Service Bundles, opening their submission forms.
URL: http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceCatalogSearch
Parameter |
Description |
---|---|
Portal_Category http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceCatalogSearch&Portal_Category=<cat_t3>&Portal_Category_1=<cat_t1>&Portal_Category_2=<cat_t2>&Portal_Category_3=<cat_t3>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceCatalogSearch&Portal_Category=11&Portal_Category_1=7&Portal_Category_2=11&BTN_Show_Items=Show Catalog Items http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceCatalogSearch&Portal_Category=11&Portal_Category_1=11&BTN_Show_Items=Show Catalog Items The parameter BTN_Show_Items=Show Catalog Items must be appended, otherwise the Category values are selected and visible, but no services are displayed on the screen. |
Use this parameter to populate the Category field on the search window, which is a tiered drop down list. The example URL opens the Service Catalog page with the Category Software/vFire already selected, and the matching results displayed. Software is REF 7, vFire is REF 11 in the database. The Portal_Category (first one) parameter's value must match the lowest tier value included in the URL, regardless of the number of tiers included. Categories are created in System Admin. The unique reference is found in REF.AR_PORTAL_CATEGORY in the database. |
Title http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceCatalogSearch&Title=<text>
http://<server_name>/<virtual_directory>/Core.aspx?Lite& Form=ServiceCatalogSearch&Title=vFire app |
Use this parameter to populate the untitled text box on the search window. The example URL opens the Service Catalog page with the words “vFire app” in the text box, and all Services listed beneath and ready for the Search button to be manually pressed. Once the Search button is pressed the list of services will be filtered to those matching the entered text. This parameter can be blank. |
BTN_MINI_SEARCH=Search http://localhost/test/Core.aspx?Lite&Form=ServiceCatalogSearch&Title=<text>&BTN_MINI_SEARCH=Search http://localhost/test/Core.aspx?Lite&Form=ServiceCatalogSearch&Title=vFire App&BTN_MINI_SEARCH=Search |
Add BTN_MINI_SEARCH=Search to the URL to automatically run the search and filter the Service Catalog by the criteria in the URL, as would pressing the Search button. The example URL opens the Service Catalog page with the words “vFire app” in the text box and the Service vFire App the only one showing beneath. |
BTN_ADDTOCART#=Order http://localhost/test/Core.aspx?Lite&Form=ServiceCatalogSearch&Quantity<ref>=<qty>&MaxItems<ref>=<max>&BTN_ADDTOCART<ref>=Order
http://localhost/test/Core.aspx?Lite&Form=ServiceCatalogSearch&Quantity7=1&MaxItems7=1&BTN_ADDTOCART7=Order The BTN_ADDTOCART parameter will not work for Service Actions that are configured to download objects or launch URLs. |
Use this parameter to order a service, as though pressing the Order button on a Service Action/Bundle. This takes the user to the Order submission form to complete the details and submit the order. The example URL opens the submission form for the vFire App service action, which is the service action with a REF of 7 in the database. These parameters must be included, even if the value is set to 1:
Service Actions/Bundles are created in vFire Core. The unique reference is found in ITEM_REF.AR_PRIMARY_ASSET in the database. |
Service Order Search
The Review Past/Current Service Orders window can be pre-populated by appending parameters to the basic Service Order search URL.
URL: http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceOrderSearchCriteria
Parameter |
Description |
---|---|
Order_No http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceOrderSearchCriteria&Order_No=<number>,<number>
Example 1:
Example 2:
|
Use this parameter to populate the Order No field on the search window. This parameter can have multiple comma separated values. Example 1 opens the Review Past/Current Orders page with values 10,15 already entered. Example 2 automatically runs the search and opens the Service Order Summary window with Orders 10 and 15 listed, if they exist. Service Order numbers are visible on the Service Order Details window in vFire Core. |
Order_Status http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceOrderSearchCriteria&Order_Status=<status_ref>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceOrderSearchCriteria&Order_Status=22 |
Use this parameter to populate the Order Status field on the search window. The example URL opens the Review Past/Current Requests criteria page with values In Progress already selected, which is the name value for REF 22 in the database. Order Statuses are created in System Admin. The unique reference is found in REF.SU_SERVICE_TITLES in the database. |
Order_State http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceOrderSearchCriteria&Order_State=<state>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceOrderSearchCriteria&Order_State=1 |
Use this parameter to pre-select one of the options of the Request State field on the search window, which is a set of radio options. The default selection is Open Orders. The example URL opens the Review Past/Current Orders page with the Order State Completed < 1 Week already selected. Options available:
|
Service_Action_Ref http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceOrderSearchCriteria&Service_Action_Ref=<sa_ref>
http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceOrderSearchCriteria&Service_Action_Ref=22
|
Use this parameter to populate the Service Action field on the search window. The example URL opens the Review Past/Current Orders page with the Service Action Consulting already selected, which is the NAME value for REF 22 in the database. Services Actions are created in vFire Core. The unique reference is found in ITEM_REF.AR_PRIMARY_ASSET in the database where ENTITY_TYPE=2 |
Service_Bundle_Ref http://<server_name>/<virtual_directory>/Core.aspx?Lite&Form=ServiceOrderSearchCriteria&Service_Bundle_Ref=<sb_ref>
Example 1:
Example 2:
The Order_State parameter is required if automating the search for service bundles through URL |
Use this parameter to populate the Service Bundle field on the search window. Example 1 opens the Review Past/Current Orders page with the Service Bundle New Starter already selected, which is the name value for REF 22 in the database. Example 2 opens the Service Order Summary page, listing all open service orders for New Starter bundles. Services Bundles are created in vFire Core. The unique reference is found in ITEM_REF.AR_PRIMARY_ASSET in the database where ENTITY_TYPE=33. |